<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Zeebe C# Client: Zeebe.Client.IZeebeClient Interface Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Zeebe C# Client
   &#160;<span id="projectnumber">0.15.0</span>
   </div>
   <div id="projectbrief">C# Client to communicate with an Zeebe Gateway</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html','../../'); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="../../de/ddc/interfaceZeebe_1_1Client_1_1IZeebeClient-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Zeebe.Client.IZeebeClient Interface Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The client to communicate with a <a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a> gateway/cluster.  
 <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Zeebe.Client.IZeebeClient:</div>
<div class="dyncontent">
 <div class="center">
  <img src="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.png" usemap="#Zeebe.Client.IZeebeClient_map" alt=""/>
  <map id="Zeebe.Client.IZeebeClient_map" name="Zeebe.Client.IZeebeClient_map">
<area href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html" title="A client with access to all job-related operation: complete a job mark a job as failed update the ret..." alt="Zeebe.Client.Api.Worker.IJobClient" shape="rect" coords="0,0,213,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a10370b9ac0ebd7feca4d63e638ddd14c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d5/dc7/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobWorkerBuilderStep1.html">IJobWorkerBuilderStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a10370b9ac0ebd7feca4d63e638ddd14c">NewWorker</a> ()</td></tr>
<tr class="memdesc:a10370b9ac0ebd7feca4d63e638ddd14c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a new job worker for jobs of a given type.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a10370b9ac0ebd7feca4d63e638ddd14c">More...</a><br /></td></tr>
<tr class="separator:a10370b9ac0ebd7feca4d63e638ddd14c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9ab9cf439f070dd5c785a2aa87e2303"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d4/d1d/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IActivateJobsCommandStep1.html">IActivateJobsCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#ae9ab9cf439f070dd5c785a2aa87e2303">NewActivateJobsCommand</a> ()</td></tr>
<tr class="memdesc:ae9ab9cf439f070dd5c785a2aa87e2303"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to activate multiple jobs of a given type.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#ae9ab9cf439f070dd5c785a2aa87e2303">More...</a><br /></td></tr>
<tr class="separator:ae9ab9cf439f070dd5c785a2aa87e2303"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83b77ca41cbde1947a976fa1193ded4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../da/d9d/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IUpdateRetriesCommandStep1.html">IUpdateRetriesCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a83b77ca41cbde1947a976fa1193ded4a">NewUpdateRetriesCommand</a> (long jobKey)</td></tr>
<tr class="memdesc:a83b77ca41cbde1947a976fa1193ded4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to update the retries of a job.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a83b77ca41cbde1947a976fa1193ded4a">More...</a><br /></td></tr>
<tr class="separator:a83b77ca41cbde1947a976fa1193ded4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6eb217d763c83f387434f9626e6f5716"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../dd/d11/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IDeployWorkflowCommandStep1.html">IDeployWorkflowCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a6eb217d763c83f387434f9626e6f5716">NewDeployCommand</a> ()</td></tr>
<tr class="memdesc:a6eb217d763c83f387434f9626e6f5716"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to deploy new workflows.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a6eb217d763c83f387434f9626e6f5716">More...</a><br /></td></tr>
<tr class="separator:a6eb217d763c83f387434f9626e6f5716"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfe56a9ebe1d96ee916d57ef133c1406"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d4/d30/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICreateWorkflowInstanceCommandStep1.html">ICreateWorkflowInstanceCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#abfe56a9ebe1d96ee916d57ef133c1406">NewCreateWorkflowInstanceCommand</a> ()</td></tr>
<tr class="memdesc:abfe56a9ebe1d96ee916d57ef133c1406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to create/start a new instance of a workflow.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#abfe56a9ebe1d96ee916d57ef133c1406">More...</a><br /></td></tr>
<tr class="separator:abfe56a9ebe1d96ee916d57ef133c1406"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac6f46aece8181403f4cefc9adfee2d8b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/d6f/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICancelWorkflowInstanceCommandStep1.html">ICancelWorkflowInstanceCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#ac6f46aece8181403f4cefc9adfee2d8b">NewCancelInstanceCommand</a> (long workflowInstanceKey)</td></tr>
<tr class="memdesc:ac6f46aece8181403f4cefc9adfee2d8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to cancel a workflow instance.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#ac6f46aece8181403f4cefc9adfee2d8b">More...</a><br /></td></tr>
<tr class="separator:ac6f46aece8181403f4cefc9adfee2d8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a715622caf01c5e5b92bea55df0aefe95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d5d/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ISetVariablesCommandStep1.html">ISetVariablesCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a715622caf01c5e5b92bea55df0aefe95">NewSetVariablesCommand</a> (long elementInstanceKey)</td></tr>
<tr class="memdesc:a715622caf01c5e5b92bea55df0aefe95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to update the variables of a workflow instance.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a715622caf01c5e5b92bea55df0aefe95">More...</a><br /></td></tr>
<tr class="separator:a715622caf01c5e5b92bea55df0aefe95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad551d03f526c8694b2a0be7f8dc26bab"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d0/d39/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IResolveIncidentCommandStep1.html">IResolveIncidentCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#ad551d03f526c8694b2a0be7f8dc26bab">NewResolveIncidentCommand</a> (long incidentKey)</td></tr>
<tr class="memdesc:ad551d03f526c8694b2a0be7f8dc26bab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to resolve an existing incident.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#ad551d03f526c8694b2a0be7f8dc26bab">More...</a><br /></td></tr>
<tr class="separator:ad551d03f526c8694b2a0be7f8dc26bab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8ab0c28694249cc682e32a24cc7889a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d8/d8d/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IPublishMessageCommandStep1.html">IPublishMessageCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#ab8ab0c28694249cc682e32a24cc7889a">NewPublishMessageCommand</a> ()</td></tr>
<tr class="memdesc:ab8ab0c28694249cc682e32a24cc7889a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to publish a message which can be correlated to a workflow instance.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#ab8ab0c28694249cc682e32a24cc7889a">More...</a><br /></td></tr>
<tr class="separator:ab8ab0c28694249cc682e32a24cc7889a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04edceb7abb5195c0c35efa0de843236"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d5/dae/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITopologyRequestStep1.html">ITopologyRequestStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a04edceb7abb5195c0c35efa0de843236">TopologyRequest</a> ()</td></tr>
<tr class="memdesc:a04edceb7abb5195c0c35efa0de843236"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the current cluster topology. Can be used to inspect which brokers are available at which endpoint and which broker is the leader of which partition.  <a href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html#a04edceb7abb5195c0c35efa0de843236">More...</a><br /></td></tr>
<tr class="separator:a04edceb7abb5195c0c35efa0de843236"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient')"><img src="../../closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html">Zeebe.Client.Api.Worker.IJobClient</a></td></tr>
<tr class="memitem:a8c429fc86a8093c8cafa7ff39e6d517b inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d53/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICompleteJobCommandStep1.html">ICompleteJobCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html#a8c429fc86a8093c8cafa7ff39e6d517b">NewCompleteJobCommand</a> (long jobKey)</td></tr>
<tr class="memdesc:a8c429fc86a8093c8cafa7ff39e6d517b inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to complete a job.  <a href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html#a8c429fc86a8093c8cafa7ff39e6d517b">More...</a><br /></td></tr>
<tr class="separator:a8c429fc86a8093c8cafa7ff39e6d517b inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f24aa0d771928b078293383a0e76aeb inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d2/d53/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICompleteJobCommandStep1.html">ICompleteJobCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html#a8f24aa0d771928b078293383a0e76aeb">NewCompleteJobCommand</a> (<a class="el" href="../../dc/ddb/interfaceZeebe_1_1Client_1_1Api_1_1Responses_1_1IJob.html">IJob</a> activatedJob)</td></tr>
<tr class="memdesc:a8f24aa0d771928b078293383a0e76aeb inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to complete a job.  <a href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html#a8f24aa0d771928b078293383a0e76aeb">More...</a><br /></td></tr>
<tr class="separator:a8f24aa0d771928b078293383a0e76aeb inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7c7675709c3a77d44c53e672ebe3b60 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d9/de4/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IFailJobCommandStep1.html">IFailJobCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html#af7c7675709c3a77d44c53e672ebe3b60">NewFailCommand</a> (long jobKey)</td></tr>
<tr class="memdesc:af7c7675709c3a77d44c53e672ebe3b60 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to mark a job as failed.  <a href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html#af7c7675709c3a77d44c53e672ebe3b60">More...</a><br /></td></tr>
<tr class="separator:af7c7675709c3a77d44c53e672ebe3b60 inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59b44132084c211cbae9d81ff99804ca inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../d4/d22/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IThrowErrorCommandStep1.html">IThrowErrorCommandStep1</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html#a59b44132084c211cbae9d81ff99804ca">NewThrowErrorCommand</a> (long jobKey)</td></tr>
<tr class="memdesc:a59b44132084c211cbae9d81ff99804ca inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="mdescLeft">&#160;</td><td class="mdescRight">Command to report a business error (i.e. non-technical) that occurs while processing a job.  <a href="../../df/d67/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient.html#a59b44132084c211cbae9d81ff99804ca">More...</a><br /></td></tr>
<tr class="separator:a59b44132084c211cbae9d81ff99804ca inherit pub_methods_interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobClient"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The client to communicate with a <a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a> gateway/cluster. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae9ab9cf439f070dd5c785a2aa87e2303"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9ab9cf439f070dd5c785a2aa87e2303">&#9670;&nbsp;</a></span>NewActivateJobsCommand()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d4/d1d/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IActivateJobsCommandStep1.html">IActivateJobsCommandStep1</a> Zeebe.Client.IZeebeClient.NewActivateJobsCommand </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Command to activate multiple jobs of a given type. </p>
<div class="fragment"><div class="line">zeebeClient</div>
<div class="line">     .NewActivateJobsCommand()</div>
<div class="line">     .JobType(<span class="stringliteral">&quot;payment&quot;</span>)</div>
<div class="line">     .maxJobsToActivate(10)</div>
<div class="line">     .WorkerName(<span class="stringliteral">&quot;paymentWorker&quot;</span>)</div>
<div class="line">     .Timeout(TimeSpan.FromMinutes(10))</div>
<div class="line">     .Send();</div>
</div><!-- fragment --> <p>The command will try to use <code>maxJobsToActivate</code> for given <code>jobType</code>. If less then the requested <code>maxJobsToActivate</code> jobs of the <code>jobType</code> are available for activation the returned list will have fewer elements. </p>
<dl class="section return"><dt>Returns</dt><dd>a builder for the command </dd></dl>

</div>
</div>
<a id="ac6f46aece8181403f4cefc9adfee2d8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6f46aece8181403f4cefc9adfee2d8b">&#9670;&nbsp;</a></span>NewCancelInstanceCommand()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../db/d6f/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICancelWorkflowInstanceCommandStep1.html">ICancelWorkflowInstanceCommandStep1</a> Zeebe.Client.IZeebeClient.NewCancelInstanceCommand </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>workflowInstanceKey</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Command to cancel a workflow instance. </p>
<div class="fragment"><div class="line">zeebeClient</div>
<div class="line"> .NewCancelInstanceCommand(workflowInstanceKey)</div>
<div class="line"> .Send();</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">workflowInstanceKey</td><td>workflowInstanceKey the key which identifies the corresponding workflow instance </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a builder for the command </dd></dl>

</div>
</div>
<a id="abfe56a9ebe1d96ee916d57ef133c1406"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abfe56a9ebe1d96ee916d57ef133c1406">&#9670;&nbsp;</a></span>NewCreateWorkflowInstanceCommand()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d4/d30/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ICreateWorkflowInstanceCommandStep1.html">ICreateWorkflowInstanceCommandStep1</a> Zeebe.Client.IZeebeClient.NewCreateWorkflowInstanceCommand </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Command to create/start a new instance of a workflow. </p>
<div class="fragment"><div class="line">zeebeClient</div>
<div class="line"> .NewCreateInstanceCommand()</div>
<div class="line"> .BpmnProcessId(<span class="stringliteral">&quot;my-process&quot;</span>)</div>
<div class="line"> .LatestVersion()</div>
<div class="line"> .Variables(json)</div>
<div class="line"> .Send();</div>
</div><!-- fragment --> <dl class="section return"><dt>Returns</dt><dd>a builder for the command</dd></dl>

</div>
</div>
<a id="a6eb217d763c83f387434f9626e6f5716"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6eb217d763c83f387434f9626e6f5716">&#9670;&nbsp;</a></span>NewDeployCommand()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dd/d11/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IDeployWorkflowCommandStep1.html">IDeployWorkflowCommandStep1</a> Zeebe.Client.IZeebeClient.NewDeployCommand </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Command to deploy new workflows. </p>
<div class="fragment"><div class="line">zeebeClient</div>
<div class="line"> .NewDeployCommand()</div>
<div class="line"> .AddResourceFile(<span class="stringliteral">&quot;~/wf/workflow1.bpmn&quot;</span>)</div>
<div class="line"> .AddResourceFile(<span class="stringliteral">&quot;~/wf/workflow2.bpmn&quot;</span>)</div>
<div class="line"> .Send();</div>
</div><!-- fragment --> <dl class="section return"><dt>Returns</dt><dd>a builder for the deploy command </dd></dl>

</div>
</div>
<a id="ab8ab0c28694249cc682e32a24cc7889a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8ab0c28694249cc682e32a24cc7889a">&#9670;&nbsp;</a></span>NewPublishMessageCommand()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d8/d8d/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IPublishMessageCommandStep1.html">IPublishMessageCommandStep1</a> Zeebe.Client.IZeebeClient.NewPublishMessageCommand </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Command to publish a message which can be correlated to a workflow instance. </p>
<div class="fragment"><div class="line">zeebeClient</div>
<div class="line"> .NewPublishMessageCommand()</div>
<div class="line"> .MessageName(<span class="stringliteral">&quot;order canceled&quot;</span>)</div>
<div class="line"> .CorrelationKey(orderId)</div>
<div class="line"> .Variables(json)</div>
<div class="line"> .Send();</div>
</div><!-- fragment --> <dl class="section return"><dt>Returns</dt><dd>a builder for the command </dd></dl>

</div>
</div>
<a id="ad551d03f526c8694b2a0be7f8dc26bab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad551d03f526c8694b2a0be7f8dc26bab">&#9670;&nbsp;</a></span>NewResolveIncidentCommand()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d0/d39/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IResolveIncidentCommandStep1.html">IResolveIncidentCommandStep1</a> Zeebe.Client.IZeebeClient.NewResolveIncidentCommand </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>incidentKey</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Command to resolve an existing incident. </p>
<div class="fragment"><div class="line">zeebeClient</div>
<div class="line">    .NewResolveIncidentCommand(incidentKey)</div>
<div class="line">    .Send();</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">incidentKey</td><td>incidentKey the key of the corresponding incident </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the builder for the command </dd></dl>

</div>
</div>
<a id="a715622caf01c5e5b92bea55df0aefe95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a715622caf01c5e5b92bea55df0aefe95">&#9670;&nbsp;</a></span>NewSetVariablesCommand()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d2/d5d/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ISetVariablesCommandStep1.html">ISetVariablesCommandStep1</a> Zeebe.Client.IZeebeClient.NewSetVariablesCommand </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>elementInstanceKey</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Command to update the variables of a workflow instance. </p>
<div class="fragment"><div class="line">zeebeClient</div>
<div class="line"> .NewSetVariablesCommand(elementInstanceKey)</div>
<div class="line"> .Variables(json)</div>
<div class="line"> .Send();</div>
</div><!-- fragment --> <dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">elementInstanceKey</td><td>the key of the element instance to set the variables for </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a builder for the command </dd></dl>

</div>
</div>
<a id="a83b77ca41cbde1947a976fa1193ded4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83b77ca41cbde1947a976fa1193ded4a">&#9670;&nbsp;</a></span>NewUpdateRetriesCommand()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../da/d9d/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1IUpdateRetriesCommandStep1.html">IUpdateRetriesCommandStep1</a> Zeebe.Client.IZeebeClient.NewUpdateRetriesCommand </td>
          <td>(</td>
          <td class="paramtype">long&#160;</td>
          <td class="paramname"><em>jobKey</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Command to update the retries of a job. </p>
<div class="fragment"><div class="line"><span class="keywordtype">long</span> jobKey = ..;</div>
<div class="line"> </div>
<div class="line">zeebeClient</div>
<div class="line"> .NewUpdateRetriesCommand(jobKey)</div>
<div class="line"> .Retries(3)</div>
<div class="line"> .Send();</div>
</div><!-- fragment --> <p>If the given retries are greater than zero then this job will be picked up again by a job subscription and a related incident will be marked as resolved. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">jobKey</td><td>the key of the job to update </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a builder for the command </dd></dl>

</div>
</div>
<a id="a10370b9ac0ebd7feca4d63e638ddd14c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10370b9ac0ebd7feca4d63e638ddd14c">&#9670;&nbsp;</a></span>NewWorker()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d5/dc7/interfaceZeebe_1_1Client_1_1Api_1_1Worker_1_1IJobWorkerBuilderStep1.html">IJobWorkerBuilderStep1</a> Zeebe.Client.IZeebeClient.NewWorker </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers a new job worker for jobs of a given type. </p>
<p>After registration, the broker activates available jobs and assigns them to this worker. It then publishes them to the client. The given worker is called for every received job, works on them and eventually completes them. </p>
<div class="fragment"><div class="line"><span class="keyword">using</span>(IJobWorker worker = zeebeClient</div>
<div class="line">     .NewWorker()</div>
<div class="line">     .jobType(<span class="stringliteral">&quot;payment&quot;</span>)</div>
<div class="line">     .handler(paymentHandler)</div>
<div class="line">     .open())</div>
<div class="line"> {</div>
<div class="line"> ...</div>
<div class="line"> }</div>
</div><!-- fragment --><p> Example JobHandler implementation:</p>
<div class="fragment"><div class="line">var handler = (client, job) =&gt;</div>
<div class="line">  {</div>
<div class="line">    String json = job.Variables;</div>
<div class="line">    <span class="comment">// modify variables</span></div>
<div class="line"> </div>
<div class="line">    client</div>
<div class="line">     .CompleteCommand(job.Key)</div>
<div class="line">     .Variables(json)</div>
<div class="line">     .Send();</div>
<div class="line">  };</div>
</div><!-- fragment --> <p>The handler must be thread-safe. </p><dl class="section return"><dt>Returns</dt><dd>a builder for the worker registration</dd></dl>

</div>
</div>
<a id="a04edceb7abb5195c0c35efa0de843236"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04edceb7abb5195c0c35efa0de843236">&#9670;&nbsp;</a></span>TopologyRequest()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../d5/dae/interfaceZeebe_1_1Client_1_1Api_1_1Commands_1_1ITopologyRequestStep1.html">ITopologyRequestStep1</a> Zeebe.Client.IZeebeClient.TopologyRequest </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Request the current cluster topology. Can be used to inspect which brokers are available at which endpoint and which broker is the leader of which partition. </p>
<div class="fragment"><div class="line">ITopology response = await ZeebeClient.TopologyRequest().Send();</div>
<div class="line">IList{IBrokerInfo} brokers = response.Brokers;</div>
</div><!-- fragment --> <dl class="section return"><dt>Returns</dt><dd>the request where you must call IFinalCommandStep&lt;T&gt;.Send </dd></dl>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>Client/IZeebeClient.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../d6/d18/namespaceZeebe.html">Zeebe</a></li><li class="navelem"><a class="el" href="../../da/d88/namespaceZeebe_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="../../d7/dd6/interfaceZeebe_1_1Client_1_1IZeebeClient.html">IZeebeClient</a></li>
    <li class="footer">Generated on Tue Jan 28 2020 21:49:16 for Zeebe C# Client by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
  </ul>
</div>
</body>
</html>
